Skip to content

setup 中方便的注册媒体查询,并在 Unmounted 时自动移除

字数
408 字
阅读时间
2 分钟

Tag: #vue #vue3 #media

Web 的多端适配需求日益增长,依靠 CSS 的媒体查询有时已经不能满足需求。为了应对复杂的需求,这时就需要 JavaScript 的介入。但是 在 setup 中注册媒体查询事件十分的繁琐。为了将重复的代码简化,特制了下面这个封装好的方法,直接调用即可注册媒体查询,并在适当的时候进行移除。

src/util/matchMedia.ts:

typescript
/**
  在 setup 中方便的注册媒体查询,并在 Unmounted 时自动移除
 */
export default function onMedia(query: string, callback: (matches: boolean) => void) {
  let media: MediaQueryList | false
  const func = () => callback(!!media && media.matches)
  // 挂载
  onMounted(() => {
    media = typeof matchMedia === 'function' && matchMedia(`(${query})`)
    // 判断是否查询成功
    if (media && typeof media.addEventListener === 'function' && media.media !== 'not all') {
      // 初始触发一次事件,然后注册事件监听
      func()
      media.addEventListener('change', func)
    }
    else {
      // 出错时的提示
      if (import.meta.env.VITE_APP_MODE !== 'production')
        console.error(`Media query failed,Query Params:"${query}"`)
    }
  })

  // 移除
  onUnmounted(() => {
    if (media && typeof media.removeEventListener === 'function')
      media.removeEventListener('change', func)
  })
}

使用方法

调用该方法的组件在 Mounted 时会触发一次回调函数,之后每当查询结果变更时会触发一次。如果因为浏览器不支持或者参数错误导致媒体查询失败,会在 console 中打印一条错误,并且不会触发任何的 callback

vue
<script setup lang="ts">
import onMedia from '~/util/matchMedia'

onMedia('max-width: 640px', (matches) => {
  console.log('媒体查结果是否匹配:', matches)
})
</script>

贡献者

页面历史

撰写

布局切换

调整 VitePress 的布局样式,以适配不同的阅读习惯和屏幕环境。

全部展开
使侧边栏和内容区域占据整个屏幕的全部宽度。
全部展开,但侧边栏宽度可调
侧边栏宽度可调,但内容区域宽度不变,调整后的侧边栏将可以占据整个屏幕的最大宽度。
全部展开,且侧边栏和内容区域宽度均可调
侧边栏宽度可调,但内容区域宽度不变,调整后的侧边栏将可以占据整个屏幕的最大宽度。
原始宽度
原始的 VitePress 默认布局宽度

页面最大宽度

调整 VitePress 布局中页面的宽度,以适配不同的阅读习惯和屏幕环境。

调整页面最大宽度
一个可调整的滑块,用于选择和自定义页面最大宽度。

内容最大宽度

调整 VitePress 布局中内容区域的宽度,以适配不同的阅读习惯和屏幕环境。

调整内容最大宽度
一个可调整的滑块,用于选择和自定义内容最大宽度。

聚光灯

支持在正文中高亮当前鼠标悬停的行和元素,以优化阅读和专注困难的用户的阅读体验。

ON开启
开启聚光灯。
OFF关闭
关闭聚光灯。

聚光灯样式

调整聚光灯的样式。

置于底部
在当前鼠标悬停的元素下方添加一个纯色背景以突出显示当前鼠标悬停的位置。
置于侧边
在当前鼠标悬停的元素旁边添加一条固定的纯色线以突出显示当前鼠标悬停的位置。